Azure Synapse

Following sections explain the reverse engineering options for an Azure Synapse.

Parameter

Description

Additional Information
Reverse Engineer From Specifies whether you want to reverse engineer from a script or database

Database: Indicates that the model is reverse engineered from a database

Script File: Indicates that the model is reverse engineered from a script
File Specifies the script file location

This option is available when Script File is selected. Click Browse and select a script file from your directory.

You can use Generative AI to generate a new script from a natural language prompt. For more information, refer to the AI-Powered Data Modeling topic.

Parameter

Description

Additional Information
Authentication

Specifies the database connection authentication type.

Select Database Authentication to connect using the database login credentials. Or, select Multi Factor Authentication type to use multi-factor authentication for database connection.

 Multi Factor Authentication is only available for ODBC connection.
Connection Method Specifies the type of connection you want to use. With SQL Pool, select JDBC to connect using JDBC. Or, select ODBC to connect using the ODBC data source that you have defined.

Fabric Lakehouse supports only ODBC data source.

 Reverse engineering a model from a database using the ODBC connection retrieves only 64 characters.
ODBC Data Source Specifies the data source to which you want to connect. The drop-down list displays the data sources that are defined on your computer. This option is available only when Connection Method is set to ODBC.
Invoke ODBC Administrator Specifies whether you want to start the ODBC Administrator software and display the Select Data Source dialog. You can then select a previously defined data source, or create a data source. This option is available only when Connection Method is set to ODBC.
Connection String

Specifies the connection string based on your JDBC instance and Azure Synapse database name in the following format:

jdbc: sqlserver://<server name>.sql.azuresynapse.net:1433;

Fabric Lakehouse supports only ODBC data source.

For example, jdbc:sqlserver://localhost.sql.azuresynapse.net:1433;

This option is available when Connection Method is set to JDBC.
Database Specifies the name of the database that you want to connect to

Fabric Lakehouse supports only ODBC data source.

 This option is available when Connection Method is set to JDBC.

Parameter

Description

Additional Information
Available Schemas Displays the available schemas  
Selected Schemas Displays the selected schemas  

Parameter

Description

Additional Information
Available Tables Displays the available tables  
Selected Tables Displays the selected tables  

Parameter

Description

Additional Information
Option Set Specifies the option set template for reverse engineering

Open: Use this option to open a saved XML option set file.

Save: Use this option to save the configured option set.

Save As: Use this option to save an option set either in the model or in the XML format at some external location.

Delete: Use this option to delete an option set.

<Option Set Name> Specifies the objects to be reverse engineered according to the selected option set. You can edit this list.  

Parameter

Description

Additional Information
Glossary CSV File Specifies the naming standard glossary file in the .CSV format  
System Objects Specifies whether to reverse engineer system objects and user tables, or only user tables  
Tables/Views Owned By Specifies tables that are reverse engineered based on the ownership

All: Indicates that all the tables are reverse engineered regardless of the owner

Current User: Indicates that only those tables that are owned by the current user are reverse engineered

Owners (comma separated): Indicates that only the tables owned by the users specified here are reverse engineered. Enter the usernames in capital letters.
Table Filter (comma separated) Specifies the tables that you want to set as filter criteria. To specify multiple tables, use a comma-separated list. For exact matches, mention table names in upper case inside double quotes(for example, "TABLE1"). To use wild cards, mention table names without double quotes (for example, TABLE1).
Infer Specifies whether you want to infer primary keys or relationships, or both

Primary Keys: Indicates that primary key columns are inferred for the tables that are based on defined indexes

Relations: Indicates that the relationships between tables based on either primary key column names or defined indexes are inferred. Select this option and then specify whether to use primary key column names or defined indexes.

The following options are available only when Infer is set to Relations.

Indexes: Indicates that the relationships from the table indexes are inferred. Relationships are inferred from table indexes only if the primary key columns of the parent table are part of the index in the child table.

Names: Indicates that the relationships from the primary key column names are inferred. Relationships are inferred from columns names only if all of the primary key columns of the parent are in the child table.
Case Conversion of Physical Names Specifies how the case conversion of physical names is handled

None: Indicates that the same case is preserved as it appears in the script file

lower: Indicates that the names are converted to lower case

UPPER: Indicates that the names are converted to upper case

Force: Indicates whether the physical name property of all the logical/physical models is overridden. If this option is not enabled, all logical and physical names are set to the same value after the process completes. If this option is enabled, the logical/physical link is broken between the logical and physical name.
Case Conversion of Logical Names Specifies how the case conversion of logical names is handled

None: Indicates that the same case is preserved as it appears in the script file

lower: Indicates that the names are converted to lower case

UPPER: Indicates that the names are converted to upper case

Mixed: Indicates that the mixed-case logical names are preserved
Include Generated Triggers Specifies whether erwin-generated triggers are loaded during the reverse engineer process  

Parameter

Description

Additional Information
Model Specifies the location and name of the reverse-engineered model

For example: C:\Scheduler\<Model Name>.erwin

When you schedule a job on a remote server, ensure the model path is same for remote and local server.
Mart Folder Specifies the location or library in your mart where the reverse-engineered model is saved
 To use this option, ensure that you are connected to mart. For more information, refer to the Connecting to Mart topic.
Complete Compare Specifies whether the Complete Compare (CC) process should run while reverse engineering  
Output File Specifies the location of the CC output file generated  
File Specifies that the target model location is on the local system  
Mart Specifies that the target model location is in the mart  
Using Latest Version Specifies whether the target model is the latest version of the model in the mart This option is available only when Mart is selected.
Save To Mart Specifies whether the reverse-engineered model is saved to the mart This option is available only when Using Latest Version is selected.
Target Model Specifies the location of the target model for CC  
Option Set Specifies the option set that is used for CC

Advanced Default Option Set: Indicates that all erwin DM metadata is included. CC works the slowest with this option.

Speed Option Set: Indicates that only the essential metadata is included. CC works the fastest with this option set.

Standard Default Option Set: Indicates that standard metadata is included. CC works fast with this option set compared to the Advanced option set.

In addition to the above options, click Browse to select a custom option set for complete compare.

Compare Level

Specifies the selection type for the compare

Logical / Physical: Compares all objects on the logical or physical level of a model

Logical: Compares all objects on the logical level of a model

Physical: Compares all objects on the physical level of a model

Database: Compares all objects on the database level of a model

When using Lakehouse via scheduler, the start service does not function as expected. As a workaround, you can use start service by command.

Parameter

Description

Additional Information
erwin Project Specifies whether to configure the model for an existing erwin project  
Model Name Specifies the name of the erwin project  
Location Specifies the location of the project